iT邦幫忙

2024 iThome 鐵人賽

DAY 5
0

今天開始終於我們實作的部分,我應該會照著 Python 官方文件的流程去執行各個步驟來上傳我們的套件到 PyPI,不過在那之前,我們需要先在我們的 Github 上面建立專案,才能上傳到 PyPI 上。

登入 Github

第一步會需要登入 Github,如果已經有帳號的人就直接登入很簡單,如果還沒申請帳號的,可以先從 Github 官網 進去後點選右上角的 Sign up 進入申請畫面。
https://ithelp.ithome.com.tw/upload/images/20240919/20163024xKbF49GWeb.png

進去後會先要你填信箱,密碼與暱稱。
https://ithelp.ithome.com.tw/upload/images/20240919/2016302455zY6g9NN0.png

填完會問你要不要收到他們的最新訊息,可以不用勾選沒關係,自己斟酌。
接下來回答認證問題跟從信箱獲得認證碼輸入後,就完成帳號申請了。再來就能直接輸入帳號密碼登入,Github 也有提供雙重認證,想讓自己的帳號更安全的也可以去申請,這邊就不多做介紹了。
https://ithelp.ithome.com.tw/upload/images/20240919/20163024vkFywDaz8k.png

創建 Repository

新登入的帳號會長得像下圖,分成三個區塊:

  1. 最左邊是進入創建 Repository 流程
  2. 分兩個區塊
    2-1. 左邊的區塊是快速創建 Repository,直接填寫名稱跟選擇要公開(public)還是私人(private)
    2-2. 建立一個個人 README.md,有點像是可以用 Markdown 格式寫自我介紹的感覺,之後會在 Github 個人頁顯示這個介紹
  3. 推薦的其他人的 Repository

https://ithelp.ithome.com.tw/upload/images/20240919/20163024THvaDlJC5A.png

簡單介紹 Repository,就是我們存放原始碼在 Github 的地方,之後可以使用 Github 提供的連結以及 git 的指令來操作,就能在本地端編輯原始碼並上傳回 Github 上,這陸續也會介紹。
接著我們是不宜遲就點選 Create Repository 來創建我們第一個 Repo(Repository 簡寫之後都會用這個來代替) 吧。

進入創建頁面,首先要填的就是 Repo 的名稱,這個在之後修改會比較麻煩,所以建議先想好再填,不過如果真的不小心填錯之後也是能改的,不用太擔心。這次因為是棒球的 Python 套件,所以我把套件命名為 baseball-stats-python,幾個原因,一個是不想跟 pybaseball 太像,另一個是我自己比較喜歡 kebab-case(用 - 分隔名詞) 的命名方式,相較於 snake_case(用 _ 分隔名詞) 或是全部黏在一起,這個就比較像是個人喜好,不太會影響功能。

輸入完名稱系統會幫你確認能不能使用,可以的話就會有一個綠色的小勾在旁邊,代表可以使用。下面一欄是這個 Repo 的介紹,這個可以先不用輸入,之後修改也滿簡單的。
https://ithelp.ithome.com.tw/upload/images/20240919/20163024SEFccGNLSO.png

再來依序要選擇:

  1. 是否公開或隱藏,因為我們要給其他人使用,所以選擇公開(public)
  2. 是否幫我們創建 README 檔,這個也是會在我們 Repo 頁顯示介紹的檔案,這邊我建議可以請他先幫我們建立一個後我們再自己修改,所以把他勾起來
  3. 是否幫我們創建 .gitignore,在把程式碼上傳到 Github 的時候,可以不用把所有檔案都上傳,這時候就可以使用這個檔案裡告訴 git 哪些檔案不用上傳。不過我們暫時還不確定哪些不用上傳,所以這邊可以先不勾選,之後再自己加就好了
  4. 是否加入 License (授權書或許可證),在我們公開我們的程式碼的時候,也可以透過 License 來限制其他人怎麼使用我們的程式碼,根據限制內容有不同的 License 可以選擇,在之後的篇章會想跟大家介紹有哪些 License 可以使用,讓大家分享自己的程式碼的時候可以找到最適合自己的 License 使用。這邊先不選,等介紹完我們也可以再自己加

這些都選完後就能點選創建,完成後就能看到我們的專屬 Repo 頁了,可以看到我們剛才如果有請 Github 幫我們創建 README 的話就會出現在下方,目前還沒有任何內容,不過我們也完成第一步了。

本日小結

今天終於建出 Repo 了,不知道這樣的進度還行不行,我自己原本是預計前面這邊很快就能結束,但自己在寫的時候又發現好像可以講細一點,就越寫篇幅越多了,希望介紹的還可以。
明天會介紹各個 License,如果篇幅夠的話會介紹一些 git 指令,感謝大家耐心看完這篇文章,一樣如果有任何問題與建議歡迎在留言告訴我,明天見 掰掰。


上一篇
Day 04 - PyPI 與 Github
下一篇
Day 06 - Open Source License
系列文
上次介紹的棒球套件很少更新了,那就只好自己寫一個!?31
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言